Entity Index (ID) Discovery

Use the following URL to retrieve the entity index information. The following attributes are specified for the last interval:

■

id – node ID

■

description – short textual description

URL

/api/v1/kpi/current/<app>/<group>/<ent>
/api/v1/kpi/history/<app>/<group>/<ent>

HTTP Method

GET

Supported Parameters

Parameter	Type	Description
?before=<Index>	Number	Returns the entities (indexes) before the specified entity index.
?after=<Index>	Number	Returns the entities (indexes) after the specified entity index. For example, to return a list of all IP Groups after Index 0 (i.e.,1, 2, 3, and so on): /api/v1/kpi/current/sbc/callStats/ipGroup?after=0
?limit=<Count>	Number	Returns the first number (count) of listed entities (indexes), starting from Index 0. For example, to request the first 3 IP Groups (i.e., Index 0, 1, and 2): /api/v1/kpi/current/sbc/callStats/ipGroup?limit=3.
id=<Index>	Number	Returns the entity of the specified Index. For example, to return IP Group Index 1: /api/v1/kpi/current/sbc/callStats/ipGroup?id=1
?detailed=true|false	String	When it equals false (default is enabled) some fields are not returned in the response (e.g., name and description).
<Cursor Information>	String	Returns next (after) or previous (before) results (see Cursor-based Pagination for more information).

HTTP Responses

■

200 OK

■

204 No Content – nothing to discover

■

400 Bad Request – bad query parameter or invalid path

Example

■

Request:

GET /api/v1/kpi/current/sbc/callStats/ipGroup?after=0 HTTP/1.1
Host: 10.4.219.229

■

Response:

  HTTP/1.1 200 OK
Content-Type: application/json
{
    "items": [
        {
            "id":"1",
            "name": "Teams PS",
            "description": "Teams server",
            "url": "/api/v1/kpi/current/sbc/callStats/ipGroup/1"
        },
        {
            "id": "2",
            "name": "Teams-c",
            "description": "Teams client",
            "url": "/api/v1/kpi/current/sbc/callStats/ipGroup/2"
        },
       …
     ]
}